home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / commoditys / mmbcommodity / mmbcommodity.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  16KB  |  313 lines

  1. @DATABASE "MMBCommodity V1.2"
  2. @NODE MAIN "MMBCommodity V1.2"
  3.                       MMBCommodity V1.2 Documentation             Sep., 1994
  4.                       Roland Janus
  5.                       Mittlere Strasse 5
  6.                       4056 Basel
  7.                       SWITZERLAND
  8.                       2:301/212.4@FidoNet
  9. - The first 3 chapters were taken from the GadToolsBox-docs. More or less.
  10. Thanxs Jan. (I hope you don't mind). :-)
  11. @{"  1.) Disclaimer              " link Disclaimer}
  12. @{"  2.) Copyright/Distribution  " link Copyright}
  13. @{"  3.) Electronic Distribution " link Distribution}
  14. @{"  4.) Purpose                 " link Purpose}
  15. @{"  5.) Requierments            " link Requierments}
  16. @{"  6.) Fast start              " link Faststart}
  17. @{"  7.) Features                " link Features}
  18. @{"  8.) Installation/Removing   " link Installation}
  19. @{"  9.) Template                " link Template}
  20. @{" 10.) Insert special events   " link Specialevents}
  21. @{" 11.) Bugs                    " link Bugs}
  22. @{" 12.) Problems                " link Problems}
  23. @{" 13.) History                 " link History}
  24. @ENDNODE
  25. @NODE Disclaimer
  26.  1) Disclaimer                                                            
  27. The  author  cannot  be  held liable for the suitability or accuracy of this
  28. manual   and/or  the  program(s)  it  describes.   Any  damage  directly  or
  29. indirectly  caused by the use or misuse of this manual and/or the program it
  30. describes is the sole responsibility of the user her/him self.
  31. @ENDNODE
  32. @NODE Copyright
  33.  2) Copyright/Distribution                                                
  34. MMBCommodity,  (c) Copyright 1994, Roland Janus.  All rights reserved.  This
  35. program  is  GIFTWARE,  so  if  you  use  this  program  you  should send me
  36. something.   Anything.  I'd like to get something from your home-town.  This
  37. program  may  be  freely  distributed  as  long  as  all  documentation  and
  38. executable(s) remain unchanged and are included with the distribution.  Also
  39. no  profit  is  to be made by selling this program.  You may not charge more
  40. than  Fred  Fish does for a single library disk.  Commercial distribution is
  41. NOT allowed without written permission from the author.
  42. @ENDNODE
  43. @NODE Distribution
  44.  3) Electronic Distribution                                               
  45. It  is  allowed  for  non-commercial BBSs to distribute this archive.  NOTE:
  46. All  files  listed  below  MUST  be distributed together.  None of the files
  47. listed below may be distributed on it's own!  They may of course be archived
  48. with LHA or any other archiver.
  49. MMBCommodity/MMBCommodity
  50. MMBCommodity/MMBCommodity.info
  51. MMBCommodity/MMBCommodity.guide
  52. MMBCommodity/MMBCommodity.guide.info
  53. @ENDNODE
  54. @NODE Purpose
  55.  4) Purpose:                                                              
  56. I  always  thought  there  was no program which satisfied my needs to use my
  57. 3-button-mouse.
  58. This is not only a 'if middlemousebutton pressed then do shift'-commodity.
  59. This is the ultimative 3-buttons-mouse-commodity. ;-)
  60. @ENDNODE
  61. @NODE Requierments
  62.  5) Requierments:                                                         
  63. - >=  OS2.x (V36 should work).  Are there still people with 1.2/1.3?
  64.   (Yes,  but let's ignore them.) Pitty and again a reason to update!  ;-)
  65.   Go with the future, dude.
  66. - 3-button-mouse...
  67. @ENDNODE
  68. @NODE Faststart
  69.  6) Fast start:                                                           
  70. For a fast try, simply type: MMBCommodity.
  71. It  detaches itself from the shell so there is no need for a "Runback", "Run
  72. >NIL:" or something similar.
  73. Default-setting for the MIDBUTTON is: SHIFT (LSHIFT!RSHIFT)
  74. IMPORTANT:
  75. You  have  to read the docs, because some of the settings may not be correct
  76. or not set at all.  I know this is boring, but believe me, it's worth it.
  77. CONWINDOWPATTERN has no default if started from a shell.
  78. @ENDNODE
  79. @NODE Features
  80.  7) Features:                                                             
  81. - Commodity.
  82. - Almost freely setable definitions (wise ones!) for the MIDBUTTON (MMB).
  83. - 3 more qualifiers/codes in conjunction with the RIGHTBUTTON.
  84. - Releasing  the  MIDBUTTON  inserts  the marked  text from the shell in the
  85.   shell-window.  (Mark the text with the mouse and press MIDBUTTON once
  86.   (see CONWINDOWPATTERN)).
  87. - Double-clicking  with  the MIDBUTTON is the same as clicking the MIDBUTTON
  88.   once.  (MagicFileRequester).
  89. - Leftymouse.
  90. - Font-sensitive memory / clock-window.
  91. - Mouselock for x or y-mousemovements.
  92. - Windowtofront.
  93.   The Window is always in front of all other windows on the WB.
  94. - Shuffler. Again ;-).
  95. - WindowHotKey -> Memory / clock-window.
  96. - Tested with Enforcer and Mungwall.
  97. - Just using about 0.2% CPU-time (XOper) on my A2000, GVP, OS3.1.
  98. @ENDNODE
  99. @NODE Installation
  100.  8) Installation/Removing:                                                
  101. Move the icon to SYS:WBStartup and edit the tooltypes.
  102. That's all. But you have to edit the tooltypes!
  103. To quit MMBCommodity start it again or use Exchange.
  104. @ENDNODE
  105. @NODE Template
  106.  9) Template:                                                             
  107. "C=CX_PRIORITY/K/N,X=XPOS/K/N,Y=YPOS/K/N,R=REFRESHRATE/K/N,T=TASKPRI/K/N,
  108. W=WINDOW/K,S=SHUFFLER/K,L=MOUSELOCK/K,F=WINDOWTOFRONT/K,
  109. U=USEFRONTPUBSCREEN/K,Y=LEFTYMOUSE/K,D=DOUBLEMMB/K,M=MMBKEY/K,1=FIRSTKEY/K,
  110. 2=SECONDKEY/K,3=THIRDKEY/K,P=CONWINDOWPATTERN/K,H=WINDOWHOTKEY/K"
  111. CX_PRIORITY:
  112. ------------
  113. Most  of  the  commodities  which  I know of use the priority 0, but because
  114. MMBCommodity  is  designed to create events especially to emulate events for
  115. other  commodities,  it  should  always be set higher, to make sure "I'm the
  116. first".
  117. Default:  10
  118. XPOS:
  119. -----
  120. Defines the x-position of the small window with the available memory and the
  121. actual time.
  122. Default: in the middle of the screen.
  123. YPOS:
  124. -----
  125. Defines  the  y-position  of the...  blah blah. See above.
  126. Default:  0, at the top of the screen.
  127. REFRESHRATE:
  128. ------------
  129. Defines the time between the update time of the free memory and the time.
  130. Default: 2 seconds (values less than 1 will be ignored!)
  131. TASKPRI:
  132. --------
  133. Defines the priority of the task (process).
  134. Default: 5 (values less than 0 will be ignored!)
  135. WINDOW:
  136. -------
  137. Memory / time-window? YES or NO.
  138. Default: YES
  139. SHUFFLER:
  140. ---------
  141. Screenshuffler? YES or NO.
  142. This  shuffler  will  activate  the first window on the screen.  But, if the
  143. screen    is   the   workbench   it   ignores   all   WB-windows   and   the
  144. MMBCommodity-window.   So,  if  there  is  no other window on the screen, it
  145. would  activate the shell-window.  I prefer this, so I did this shuffler for
  146. my  WB.   ;-)  There  is a special qualifier, which one cannot be changed in
  147. this  version:   LEFT_SHIFT.   If you use the screenshuffler with LEFT_SHIFT
  148. down,  the original shuffler-routine is used and no window will be activated
  149. by MMBCommodity.
  150. Default: NO
  151. MOUSELOCK:
  152. ----------
  153. Mouselock? YES or NO.
  154. If  you  press  CONTROL  and  move  the mouse, all y-angle-movements will be
  155. disabled.  The same works with the x-angle if you press LEFT_SHIFT.
  156. Default: NO
  157. WINDOWTOFRONT:
  158. --------------
  159. Memory / clock-window always in front of other WB-windows? YES or NO.
  160. Default: YES
  161. USEFRONTPUBSCREEN:
  162. ------------------
  163. Let's the window jump to the pubscreen in front.
  164. Only  pubscreens,  because doing this with other screens could cause a crash
  165. when they get closed and the window stayed open.
  166. (Uses the value in REFRESHTIME for updatechecking)
  167. Default: NO
  168. WINDOWHOTKEY:
  169. -------------
  170. Open / close the window. Usefull for changing the Prefs/#?-files.
  171. (Screenmode etc.)
  172. The  window  will  open always on the default publicscreen, so if you use an
  173. utility  that  changes  the  publicscreen  according to the frontscreen, you
  174. could  re-open  the  window  on  this  screen with pressing the WINDOWHOTKEY
  175. twice.  (Mayby this will be made automatically in a future version).
  176. If  you use the hotkey while you use another pubscreen as the Workbench, the
  177. window will open on the other screen.
  178. Like for USEFRONTPUBSCREEN:  Only pubscreens are used.  If there is no other
  179. pubscreen available, the Workbench will be used again.
  180. Default: CONTROL LALT j
  181. LEFTYMOUSE:
  182. -----------
  183. Exchange the functions of the left and the right mousebuttons.
  184. Default: NO
  185. DOUBLEMMB:
  186. ----------
  187. Emulate MIDBUTTON? YES or NO.
  188. If  you  doubleclick  the  MIDBUTTON  with the same clickspeed as you set in
  189. 'Prefs/Input',  MMBCommodity  creates  a  single (!) MIDBUTTON-event.  I did
  190. this  because the MagicFileRequester uses this to go to the parent directory
  191. and I would really miss this feature.
  192. Default: YES
  193. CONWINDOWPATTERN:
  194. -----------------
  195. This defines the name for the shell-windows you are using.
  196. My shell-windows have always the name "AmigaShell", but I've heard there are
  197. really  weird  titles used.  But this should be no problem.  You can use all
  198. possible  patterns  that  are supported by AmigaDos.  If you have done this,
  199. mark  text  in  your  shell-window  with your mouse and press the MIDBUTTON.
  200. After  you  released  (!)  the  button  AND  the  pointer  is  still  in the
  201. shell-window,  the marked text will be inserted into the window.  I saw this
  202. feature on HPs with HP-Unix.  I just had to add this.  If you have "ConClip"
  203. in  your startup-sequence the text is automatically copied in the clipboard,
  204. so  it  is  possible  to  insert the marked text with SNAP or POWERSNAP into
  205. other   applications,   too.    This   feature  simulates,  of  course,  the
  206. "RIGHT_COMMAND c" and "RIGHT_COMMAND v" keys.
  207. @ENDNODE
  208. @{"MMBKEY, FIRST-,SECOND-,THIRD-KEY" link Specialevents}
  209. @NODE Specialevents
  210.  10) Insert special events with MMB and RMB:                              
  211. Now the tougher things:
  212. First example:
  213. --------------
  214. There  are  a  lot  of  programs  (inputhandler  / commodities) which need a
  215. qualifier to activate some functions.  So, everytime you want to use this in
  216. conjuction  with the mouse, you have to press a few keys at the same time on
  217. the  keyboard.   In  my  case  this  is  'Snap  V1.64' from Mikael Karlsson.
  218. MMBCommodity  is designed to create events for other programs.  The best way
  219. for you to understand this feature, is an example:
  220. My settings for Snap are:
  221. TEXTQUAL (textsnapping): LALT
  222. GFXQUAL (gfxsnapping):   RALT
  223. INSERTKEY (write text):  LCOMMAND i
  224. This means you could have these settings for MMBCommodity:
  225. MMBKEY=SHIFT
  226. FIRSTKEY=LALT
  227. SECONDKEY=RALT
  228. THIRDKEY=LCOMMAND i
  229. What happens:
  230. - If  you  press  the  MIDBUTTON  this will emulate the shift key for use on
  231.   menus and icon's.
  232. - If  you  hold  the  MIDBUTTON  and  press  the RIGHTBUTTON once, this will
  233.   emulate LEFT_ALT.  So  you  can mark the text with the LEFTBUTTON and then
  234.   release the MIDBUTTON.
  235. - If you press the RIGHTBUTTON the second time, (the time between the clicks
  236.   is meaningless!), it will emulate RIGHT_ALT.
  237. And, of course, at the third time this will be 'LEFT_COMMAND i' and the text
  238. is  inserted  in  the  active input.  This means you don't have to touch the
  239. keyboard and you could, with a few mousemoves and clicks, copy text and gfx.
  240. (Of course these are my settings for Snap).
  241. Second Example:
  242. ---------------
  243. Asuming  you're  using  a  tool  which  can  move  windows without using the
  244. dragbar,  like  DragIt.   If  you  did  set  the  qualifier  for  DragIt  to
  245. RIGHT_SHIFT,  you  could  set  "MMBKEY" for MMBCommodity to "LEFT_SHIFT" and
  246. "FIRSTKEY"  to  RIGHT_SHIFT.   Now,  you  could  use  the  MidButton  as the
  247. MultiChoice-key  further  and  with  two mouseclicks (hold the MIDBUTTON and
  248. click RIGHT_BUTTON once) move and resize windows.
  249. BUT: There are a few restrictions!
  250. FIRST:
  251. Only RAWKEY codes with this qualifiers are allowed and usefull!
  252. - LSHIFT
  253. - RSHIFT
  254. - SHIFT    (LSHIFT!RSHIFT)
  255. - CAPSLOCK
  256. - CAPS (SHIFT!CAPSLOCK)
  257. - CONTROL
  258. - LALT
  259. - RALT
  260. - ALT (LALT!RALT)
  261. - LCOMMAND
  262. - RCOMMAND
  263. Instead of L and R, LEFT_ and RIGHT_ are also allowed.
  264. Others will be ignored WITHOUT NOTICE.
  265. SECOND:
  266. Because  it's  really  senseless  to create a RAWKEY event with a code (like
  267. SHIFT  x)  in  FIRSTKEY  and then a qualifier in SECONDKEY, all keys after a
  268. RAWKEY  definition  will  be  ignored  and  the original RIGHTBUTTON will be
  269. untouched.
  270. WHY THIS?
  271. Because,  every  time  you define a CODE-event-definition, you will create a
  272. event  which  creates almost a visible (!) event itself.  Like a letter in a
  273. Shell-window or editor etc.
  274. So, it's necessary to use RAWKEYS with a CODE at the end of all definitions,
  275. to prevent a conflict with other events.
  276. I can remove this if someone insists. ;-)
  277. @ENDNODE
  278. @NODE Bugs
  279.  11) Bugs:                                                                
  280. None known. Now. ;-)
  281. @ENDNODE
  282. @NODE Problems
  283.  12) Problems:                                                            
  284. - LeftyMouse could cause a few problems:
  285. Programs  which  do  special things with the mousebuttons like DirectoryOpus
  286. and DPaint react strange.  But as I noticed, this seems to be a problem with
  287. any "leftymouse"-program.
  288. However, I'm righthanded. ;-)
  289. If  anybody discovers (or doesn't) this problems with other programs using a
  290. leftymouse-feature, I will be happy to hear (or read) about it.
  291. - If you have problems controling other programs like KCommodity, this could
  292. be  because KCommodity uses an inputhandler with a priority higher (standard
  293. 55) then the commodity-network (53) itself.
  294. Set  the  inputhandler-priority for the naughty program lower then 53 and it
  295. should work.
  296. @ENDNODE
  297. @NODE History
  298.  13) History:                                                             
  299. ===========================  1. Sep. 94 ====================================
  300. V1.2 - Now the memory and time will only be refreshed when they changed.
  301.        (CPU-Usage down from 2% to 0.2%)
  302.      - Added an application-example
  303.      - Changed the default (icon) for CONWINDOWPATTERN
  304.        to (#?Shell#?|#?Dos#?)
  305. =========================== 13. May  94 ====================================
  306. V1.1 - bug removed which caused ignoring the "WINDOW"-tooltype.
  307.      - added USEFRONTPUBSCREEN which allows automatic jumping to the
  308.        pubscreen in front
  309. =========================== 12. Feb. 94 ====================================
  310. V1.0 first publiced version
  311. @ENDNODE
  312. $VER: MMBCommodity.guide 1.2 (1.9.94)
  313.